home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 January: Mac OS SDK / Dev.CD Jan 97 SDK2.toast / Development Kits (Disc 2) / OpenDoc / OpenDoc Development / Debugging Support / OpenDoc™ Source Code / Storage / Bento / CM / GlbNames.h < prev    next >
Encoding:
C/C++ Source or Header  |  1996-08-28  |  16.4 KB  |  366 lines  |  [TEXT/MPS ]
  1. /*
  2.     File:        GlbNames.h
  3.  
  4.     Contains:    Container Manager Global Name Values Interfaces
  5.  
  6.     Written by:    Ira L. Ruben
  7.  
  8.     Owned by:    Ed Lai
  9.  
  10.     Copyright:    © 1991-1994 by Apple Computer, Inc., all rights reserved.
  11.  
  12.     Change History (most recent first):
  13.  
  14.          <2>     8/26/94    EL        #1182319 Matches GlbNames.c.
  15.          <2>      5/9/94    MB        #1162181: Changes necessary to install MMM.
  16.          <1>      2/3/94    EL        first checked in
  17.  
  18.     To Do:
  19. */
  20.  
  21. /*---------------------------------------------------------------------------*
  22.  |                                                                           |
  23.  |                           <<<  GlbNames.h   >>>                           |
  24.  |                                                                           |
  25.  |              Container Manager Global Name Values Interfaces              |
  26.  |                                                                           |
  27.  |                               Ira L. Ruben                                |
  28.  |                                 12/12/91                                  |
  29.  |                                                                           |
  30.  |                  Copyright Apple Computer, Inc. 1991-1994                 |
  31.  |                           All rights reserved.                            |
  32.  |                                                                           |
  33.  *---------------------------------------------------------------------------*
  34.  
  35.  The routines here handle global names.  Global names are object values that are treated
  36.  speciaially.  Normally object values are written to a container and the value we keep in
  37.  the TOC is the offset to the value (and of course its length).  But we want to keep
  38.  global names around so we can handle such calls as CMGetGlobalName() which return
  39.  the global name value for the object (assuming it is such an object).  We also want to
  40.  efficiently determine if there are attempts at multiple definitions (CMRegister...()) of
  41.  the same global name.
  42.  
  43.  Special flag bits are used in the TOC entry to indicate the value is a global name and
  44.  points to it instead of being an offset.  There is room in the TOC value entry for the
  45.  offset too. It does get filled in when we actually write the global name to the container.
  46.  But the pointer must coexist so we can still get at the name string.  We can get away 
  47.  with this because a TOC value is two longs.  Thus we use one for the offset and one for
  48.  the pointer to the global name.  We therefore have to use the pointer to get at the
  49.  global name to get its length when doing the writing.  But this is getting off the track!
  50.  
  51.  Essentially a global name "belongs" to two data structures. The first is the TOC stucture
  52.  defined in  TOCEnts.h   (or .c).  As just mentioned there is a pointer from the value to
  53.  the global name.  The second data structure is the symbol table which contains the 
  54.  global names themselves.  This is a binary tree.  We can easily walk it when it comes time
  55.  to write the global names out instead of walking the more complicated TOC hunting down
  56.  just the global names (although there is nothing prohibiting that -- it was a time/space
  57.  trade-off).
  58.  
  59.  In addition to the global name in its symbol table entry, there is also a back link to
  60.  the value that points to it.  We can thus go from global name to owning object and vice
  61.  versa.  The back link is used when we write the global names to the container so that we
  62.  can fill in the offset in the object's value as mentioned above.
  63.  
  64.  This is a pretty complicated layout.  There is a potential "trap" in that TOC entries
  65.  can be deleted.  If they are, and it is one that points to a global name, we must delete
  66.  the global name too.  But deletingin in a binary tree is a pain! So what we do is 
  67.  simply mark an entry deleted by nulling out its back pointer.  The trap here is that if
  68.  we're not carful we could end up use a null pointer.  Just thought you would like to 
  69.  know that.
  70. */
  71.  
  72. #ifndef __GLOBALNAMES__
  73. #define __GLOBALNAMES__
  74.  
  75. #include <string.h>
  76. #include <setjmp.h>
  77.  
  78. #ifndef __CMTYPES__
  79. #include "CMTypes.h"
  80. #endif
  81. #ifndef __CM_API_TYPES__
  82. #include "CMAPITyp.h"
  83. #endif
  84. #ifndef __SYMMGR__
  85. #include "SymTbMgr.h"      
  86. #endif
  87. #ifndef __TOCENTRIES__
  88. #include "TOCEnts.h"   
  89. #endif
  90. #ifndef __TOCOBJECTS__
  91. #include "TOCObjs.h"   
  92. #endif
  93. #ifndef __CONTAINEROPS__
  94. #include "Containr.h"  
  95. #endif
  96. #ifndef __SESSIONDATA__
  97. #include "Session.h"          
  98. #endif
  99.  
  100.                                                                     CM_CFUNCTIONS
  101.  
  102. struct GlobalName {                                    /* Layout for a global name symbol table entry:            */
  103.     SymbolLinks         theNameLinks;            /*         standard right/left links (must be 1st)                */
  104.     struct TOCValue *theValue;                /*         back ptr to TOCValueBytes (NULL ==> deleted)    */
  105.     char        globalName[1];                        /*        start of this global name                                            */
  106. };
  107. typedef struct GlobalName GlobalName, *GlobalNamePtr;
  108.  
  109.  
  110. void *cmCreateGlobalNameTbl(ContainerPtr container);
  111.     /*
  112.     This routine MUST be called before any other global name routine is called. It is used to
  113.     set up the data needed by the other global name routines.  A "reference number" is
  114.     returned to the caller who must pass it to all the other global name routines. Any number
  115.     of global name tables can be created.  By passing the returned "reference number" to the
  116.     other routines they will operate on the corresponding table.
  117.      
  118.     Internally, i.e., in this file, the "reference number" is actually a pointer to a control
  119.     block containing the root pointer to the global name table (set to NULL here) and a use
  120.     count.  The use count is explained in cmUseGlobalNameTbl().
  121.     
  122.     This function returns the pointer if we can allocate the control block. NULL is returned
  123.     if the allocation fails.
  124.     */
  125.     
  126.     
  127. void *cmUseGlobalNameTbl(void *table, ContainerPtr container);
  128.     /*
  129.     This allows multiple users of the same global name symbol for the specified container. 
  130.     This can come about due to updating containers which want to use the global name table of
  131.     their target.  They call this routine to register the additional use of the specified 
  132.     table.  It is also returned as the function result.
  133.     
  134.     Here we register the additional use by incrementing a use count of the table.  When
  135.     cmFreeAllGlobalNames() is called to remove the global names it will decrement the use
  136.     count.  Only when the count goes to 0 is the data actually freed.
  137.     */
  138.     
  139.  
  140. char *cmIsGlobalNameObject(TOCObjectPtr typePropertyObject, CM_ULONG objectID);
  141.     /*
  142.     Given a pointer to a type or property object, which is expected to have the corresponding
  143.     standard global name object ID defined by the macros CM_StdObjID_GlobalTypeName and 
  144.     CM_StdObjID_GlobalPropName, return the pointer to the global name string if the object is
  145.     indeed for a global name.  NULL is returned if the object isn't for a global type or
  146.     property name.
  147.     */
  148.     
  149.     
  150. char *cmGetGlobalTypeName(ContainerPtr container, CM_ULONG typeID);
  151.     /*
  152.     This routine takes an object ID assumed to be a type object, and returns the global name
  153.     for that type.  A string is always returned.  If the ID does not correspond to a type,
  154.     "?" is returned as the string.
  155.     
  156.     Note, this routine differs from cmIsGlobalNameObject() in that here an object ID is
  157.     converted to its corresponding global name.  In cmIsGlobalNameObject(), it is assumed the
  158.     object has already been found.  So all we have to do here is do the find and then call
  159.     cmIsGlobalNameObject() to get the name.
  160.     */
  161.     
  162.     
  163. char *cmGetGlobalPropertyName(ContainerPtr container, CM_ULONG propertyID);
  164.     /*
  165.     This routine takes an object ID assumed to be a property object, and returns the global
  166.     name for that property.  A string is always returned.  If the ID does not correspond to a
  167.     type, "?" is returned as the string.
  168.     
  169.     Note, this routine differs from cmIsGlobalNameObject() in that here an object ID is
  170.     converted to its corresponding global name.  In cmIsGlobalNameObject(), it is assumed the
  171.     object has already been found.  So all we have to do here is do the find and then call
  172.     cmIsGlobalNameObject() to get the name.  This is exactly like cmGetGlobalTypeName() but
  173.     for property names instead of types.
  174.     
  175.     Both these routines are mainly used to generate error message inserts.
  176.     */
  177.  
  178.  
  179. #define MarkGlobalNameDeleted(g) ((GlobalNamePtr)(g))->theValue = NULL
  180.     /*
  181.     Marks a global name symbol pointed to by "g" as deleted.  Such an entry will not be
  182.     written to the container.  It is assumed that if there is an object's value pointing to
  183.     this entry, it will never be used (and should itself be deleted).
  184.     */
  185.  
  186.  
  187. #define GetGlobalNameValueBackPtr(g) (((GlobalNamePtr)(g))->theValue)
  188.     /*
  189.     This generates the TOCValue back pointer from a global name symbol table entry pointed to
  190.     by "g".
  191.     */
  192.  
  193.  
  194. #define SetGlobalNameValueBackPtr(g, v) ((GlobalNamePtr)(g))->theValue = (v)
  195.     /*
  196.     This sets the TOCValue back pointer field of a global name symbol table entry pointed to
  197.     by "g" to the value specified by "v".
  198.     */
  199.  
  200.  
  201. #define GetGlobalName(g) (((GlobalNamePtr)(g))->globalName)
  202.     /*
  203.     This generates a pointer to the global name string in a global name symbol table entry
  204.     pointed to by "g".
  205.     */
  206.  
  207.  
  208. #define GetGlobalNameLength(g) (strlen((char *)GetGlobalName(g)))
  209.     /*
  210.     This produces the length of a global name string in a global name symbol table entry
  211.     pointed to by "g".  This length does NOT include the delimiting null at the end of the
  212.     string.
  213.     */
  214.  
  215.  
  216. GlobalNamePtr cmCreateGlobalName(const void *table, const CM_UCHAR *globalName,
  217.                                                                  CMBoolean *dup);
  218.     /*
  219.     Creates and defines a new global name symbol table entry in the specified global name
  220.     table.  A global name symbol table entry consists of the name and a back pointer to the
  221.     TOCValue which will point to the symbol table entry to be able to get the value data. The
  222.     back pointer is set to NULL in the newly defined global name entry returned from here.
  223.     
  224.     The function returns a pointer to the created definition.  If dup is true, a pointer to
  225.     a previously defined entry is returned.  If NULL is returned then there was an allocation
  226.     failure and the new type could not be created.
  227.  
  228.     The back pointer is used (when cmWriteAllGlobalNames() is called) when we write global
  229.     names to the container to allow us to fill in the ACTUAL TOC value data with the
  230.     container offset to the value.     We make sure we write the global names to the container
  231.     before we write the TOC.  Thus by the time the TOC is written the offsets will be known.
  232.     
  233.     Note, it is assumed that the back pointer will be set by the caller of 
  234.     cmDefineGlobalName().
  235.     */
  236.  
  237.  
  238. GlobalNamePtr cmEnterGlobalName(const void *table, GlobalNamePtr createdGlobalName,
  239.                                                                 CMBoolean *dup);
  240.     /*
  241.     This routine takes a previously created global name symbol table entry end enters it into
  242.     the global name table.
  243.  
  244.     The function returns the entry pointer as its result when dup is false. It may NOT be the
  245.     input pointer if we are reusing a previously deleted entry.  In that case the input
  246.     pointer is freed.  
  247.     
  248.     If dup is true, a pointer to a previously defined entry is returned.
  249.     
  250.     This routine differs from cmCreateGlobalName() above in that here no global name entry
  251.     is allocated.  Indeed cmCreateGlobalName() does call this routine after it does its
  252.     allocation.  This routine is also called by buildGlobalNameTable() in  TOCEnts.c   to
  253.     enter read global names into the table.
  254.     
  255.     Caution: The caller should have only entered the name into the entry prior to call.  This
  256.                      is because we could return a pointer to a previously freed entry.
  257.     */
  258.     
  259.     
  260. GlobalNamePtr cmLookupGlobalName(const void *table, const CM_UCHAR *globalName);
  261.     /*
  262.   Finds the specified global name defined in the specified global name table.  If found,
  263.   the GlobalNamePtr to the found entry is returned.  If not found NULL is returned.
  264.     
  265.     Note, we allocate a temporary global name table entry here and then free it.  If the
  266.     allocation fails, SessionSuccess, a session status switch, is returned false.  Otherwise
  267.     SessionSuccess is true.
  268.     */
  269.  
  270.  
  271. TOCObjectPtr cmDefineGlobalNameObject(const ContainerPtr container, CM_ULONG objectID,
  272.                                                                           CM_ULONG propertyID, CM_ULONG typeID, 
  273.                                                                             CM_UCHAR *globalName, CM_ULONG generation,
  274.                                                                             CM_USHORT flags, CM_USHORT objectFlags);
  275.     /*
  276.     This routine is called to define an TOC object corresponding to a global name in the
  277.     specified container.  It is a special case of the more general cmDefineObject() routine.
  278.     See that routine for a discussion on the parameters.
  279.  
  280.     The function returns a pointer to the object if it was successfully created and NULL if
  281.     it wasn't.  An error is reported if NULL is returned.  Note, while error calls are not
  282.     supposed to return we assume here they due just to be safe!
  283.     
  284.     The only difference between this routine and cmDefineObject() is that the value is passed
  285.     as a global name string instead of a built TOCValueBytes structure.  Finally, we don't
  286.     bother returning a pointer to the value's header because here we should only have one
  287.     value for the global name.  We can always get at it if we need to through the object
  288.     itself.
  289.      
  290.     Here we take the string and build a TOCValueBytes value to point to a global name symbol
  291.     table entry which is also created from here.  The symbol table entry will have a back
  292.     pointer to the value entry we create for the object.
  293.     
  294.     The flags and objectFlags are passed just as in cmDefineObject().  However, the flags are
  295.     ORed with the kCMGlobalName flag.  This marks the value as unique and as a value with a
  296.     pointer to a global name symbol table entry. The ValueGlobal flag echos this in the value
  297.     valueHdr.
  298.     
  299.     The main reasons we don't use cmDefineObject() directly is because of the extra work
  300.     needed to be done for global names to set the back pointer in their entries. We can also
  301.     do the extra checks for attempts at multiply defining a global name object.
  302.     */
  303.     
  304.     
  305. int cmForEachGlobalName(const void *table, CMRefCon refCon,
  306.                                                 void (*action)(GlobalNamePtr globalName, CMRefCon refCon));
  307.     /*
  308.     Do (call) the specified action for each defined global name in the specified global name
  309.     symbol table. The pointer to each global name entry is passed to the action routine along
  310.     with a "refCon" which the caller can use as a communication facility to convey additional
  311.     info to the action routine. 0 is returned to indicate successfull completion.  Use the
  312.     AbortForEachGlobalName(x) (a macro) in the action routine to abort the interator.  The 
  313.     "x" is a integer which is returned from cmForEachGlobalName() so it should not be 0. 
  314.     */
  315.  
  316.  
  317. #define AbortForEachGlobalName(x) longjmp(SESSION->cmForEachGlobalNameEnv, x)
  318.     /*
  319.     Use this in routines passed to forEachGlobalName() to abort the interator. The value of x
  320.     is returned from forEachGlobalName().  It should be non-zero since 0 is the "success"
  321.     return value for forEachGlobalName().  It is assumed that the variable "container" is
  322.     the current container pointer.
  323.     */
  324.  
  325.  
  326. CMBoolean cmWriteAllGlobalNames(const void *table);
  327.     /*
  328.     This routine is called by CMCloseContainer() just prior to writing the TOC to the
  329.     container to make sure all the global names in the specified global name symbol table are
  330.     written to the (end of the) container first.  Global names are thus the last data objects
  331.     in a container before the TOC.
  332.  
  333.     The function returns true if the global names were successfully written and false
  334.     otherwise.  As usual this is as safety since the error handler should not normmaly
  335.     return.
  336.     
  337.     Note, only global names in the specified symbol table that are "owned" by the container
  338.     are written.  A container used to update a target container utilize a global symbol table
  339.     common to both.  However, only NEW global names  that are to be recorded as belonging to
  340.     the updating container are to be written into that container.
  341.     
  342.     We keep global names in memory to make it easier to get at them for such API routines as
  343.     CMGetGlobalName().  Another use is to efficiently determine if there are attempts at
  344.     multiple definitions (CMRegister...()) of the same global name.
  345.     
  346.     The price we pay for this is a complication of TOC entries in that the corresponding 
  347.     value for a global name is NOT a container offset prior to writing.  It is a pointer to
  348.     its global name symbol table entry!  By the time we return from here an offset WILL be
  349.     in the value along with the symbol table pointer.  Funny thing about that!  Just in time
  350.     for the TOC write.
  351.     */
  352.  
  353. void cmFreeAllGlobalNames(void **table);
  354.     /*
  355.     This routine is called to remove the definitions of ALL previously defined global names
  356.     in the specified global name symbol table for a container.  The caller's symbol table
  357.     pointer is set to NULL prior to return.
  358.  
  359.   Note, there may be multiple users of a global name symbol table.  Thus its use count is
  360.   passed.  It is decremented and the symbol table only freed if the count goes to 0.
  361.     */
  362.  
  363.  
  364.                                                           CM_END_CFUNCTIONS
  365. #endif
  366.